/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.impl;

import java.util.Properties;

import javax.xml.soap.SOAPMessage;

import cgl.narada.protocol.DataReceived;
import cgl.narada.protocol.Handler;
import cgl.narada.transport.TransportException;
import cgl.narada.transport.TransportHandler;
import cgl.narada.transport.TransportHandlerImpl;
import cgl.narada.wsinfra.deployment.FilterPipeline;
import cgl.narada.wsinfra.deployment.NetworkSubstrate;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.util.SoapMarshaller;

/** This class provides an implementation of the Network Substrate interface
    based on communications provided by the NB substrate. 
    
    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.4 $
*/

public class NBNetworkSubstrate implements Handler, NetworkSubstrate {
  private FilterPipeline filterPipeline;
  
  /** Deals with the transport related aspects of communication */
  private TransportHandler transportHandler;
  
  private SoapMessageRouting soapMessageRouting;
  private String moduleName = "NBNetworkSubstrate: ";


  public NBNetworkSubstrate() {
    transportHandler = new TransportHandlerImpl(this);
    soapMessageRouting = SoapMessageRouting.getInstance();
  }


  /** Register the filter pipeline with the substrate. */
  public void registerPipeline(FilterPipeline filterPipeline)
    throws DeploymentException {
    this.filterPipeline = filterPipeline;
  }


  /** Configure the networking related properties associated with the 
      substrate. */
  public void configureNetworking(Properties props) 
    throws DeploymentException {
    String commType = props.getProperty("CommType");
    if (commType == null) {
      commType = "tcp";
    }
    
    try {
      loadCommunicationsOfType(props, commType);
    } catch (TransportException transEx) {
      throw new DeploymentException(moduleName + transEx.toString());
    }
  }


  public void routeMessage(SOAPMessage soapMessage) 
    throws MessageFlowException {
    try {
      if (soapMessageRouting == null) {
	System.out.println(moduleName + "SOAPMessageRouting instance is NULL");
      }
      String sendTo = soapMessageRouting.computeDestination(soapMessage);
      System.out.println(moduleName + "Will send SOAPMessage to [" + sendTo +
			 "]");
      byte[] dataToSend = SoapMarshaller.marshallSoapMessage(soapMessage);
      sendDataTo(dataToSend, sendTo);
    } catch (Exception e) {
      e.printStackTrace();
      throw new MessageFlowException(moduleName + "Problems routing message!");
				     //e.toString());
    }
  }



  /** This method indicates that the node in question is a client */
  public boolean isClient() {
    return true;
  }
  
  
  public void handleData(byte[] data, String sender) {
    try {
      
      System.out.println(moduleName + "Received Data size->" + data.length); 
      
      if (data.length == 0) {
	System.out.println(moduleName + "Data received has length = 0");
	return;
      }
      
      SOAPMessage soapMessage = SoapMarshaller.unmarshallSoapMessage(data);
      processMessageFromNetwork(soapMessage); 
      
    } catch (Exception e) {
      e.printStackTrace();
      System.out.println(moduleName + e);
    }
    
  }

  /** Process a message that has been received over the network. */
  private void processMessageFromNetwork(SOAPMessage soapMessage) {
    if (filterPipeline == null) {
      System.out.println(moduleName + "Received SOAP message over the network"+
			 ". However, NO filter-pipeline has been registered.");
      return;
    }
    
    filterPipeline.processMessageFromNetwork(soapMessage);
  }


  /** Load communication libraries for a specific transport based on the 
      specified properties. */
  public void loadCommunicationsOfType(Properties commProps, String commType) 
    throws TransportException {
    
    transportHandler.loadCommunicationsOfType(commProps, commType);
  }
  

  /** Create a network connection to a specific host based on the specified
      properties and communications type. */
  public String createLinkTo(Properties props, String linkType) 
    throws DeploymentException { 
    try { 
      String linkId = transportHandler.setupLink(props, linkType); 
      return linkId; 
    } catch (TransportException transEx) {
      throw new DeploymentException(moduleName + transEx.toString());
    }
  }


  /** Send data over to specific location. */
  private void sendDataTo(byte[] data, String node) throws TransportException {
    transportHandler.sendData(data, node);
  }


}
